<?php
/**
 * Apidoc宏定义
 * @link https://www.kancloud.cn/cleverstone/ymb2
 * @copyright Copyright (c) 2020 Yii Manager Software LLC
 */

interface Macro
{
    /**
     * @apiDefine error500 500响应格式
     * 接口返回码code=500时JSON响应格式
     * @apiError {Number} code=500 接口返回码
     * @apiError {String} msg=业务处理失败 接口错误提示语
     * @apiErrorExample code=500
     * {
     *      "code":500,
     *      "msg":"业务处理失败"
     * }
     */
    public function error500();
    /**
     * @apiDefine error401 401响应格式
     * 接口返回码code=401时JSON响应格式
     * @apiError {Number} code=401 接口返回码
     * @apiError {String} msg=账号未授权或授权失败 接口错误提示语
     * @apiErrorExample code=401
     * {
     *      "code":401
     *      "msg":"账号未授权或授权失败"
     * }
     */
    public function error401();
    /**
     * @apiDefine error500_401 500和401响应格式
     * 接口返回码code为500和401的JSON响应格式
     * @apiError {Number} code=500 接口返回码
     * @apiError {String} msg=业务处理失败 接口错误提示语
     * @apiErrorExample code=500
     * {
     *      "code":500,
     *      "msg":"业务处理失败"
     * }
     * @apiError {Number} code=401 接口返回码
     * @apiError {String} msg=账号未授权或授权失败 接口错误提示语
     * @apiErrorExample code=401
     * {
     *      "code":401
     *      "msg":"账号未授权或授权失败"
     * }
     */
    public function error500_401();
    /**
     * @apiDefine common_header 请求头公共数据格式
     * @apiHeader {String} X-Requested-With AJAX头
     * @apiHeaderExample X-Requested-With
     * {
     *      "X-Requested-With":"XMLHttpRequest",
     * }
     */
    public function common_header();

    /**
     * @apiDefine auth_header 授权请求头部数据格式
     * @apiHeader {String} X-Api-Key Api令牌
     * @apiHeaderExample X-Api-Key
     * {
     *     "X-Api-Key": "Auth:这里是访问令牌",
     * }
     */
    public function auth_header();
}